Class OOB_Service

Used in features: Intel(R) ME defined Classes

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by OOB_Service



class OOB_Service
extends CIM_Service

General Information:
A class for handling Intel(R) ME's OOB activation(aka Intel(R) AMT provisioning) and forreporting the OOB configuration

Qualifiers:
-------------
Version=0.0.4
LOCALE=0x409
dynamic
provider=IntelMEProv


Supported Fields Summary
 string Name Key
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed . . .
 string CreationClassName Key
CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance . . .
 string SystemName Key
The Name of the scoping System.
 string SystemCreationClassName Key
The CreationClassName of the scoping System.

Methods Summary
 uint32 GetAMTProvisioningMode(mode)
Returns the current provisioning (activation) mode of the device
 uint32 isRemoteConfigEnabled(enabled)
Indicates if Remote Configuration is enabled in the MEBx
 uint32 GetActivationTLSMode(mode)
Indicates whether the device is using TLS-PSK or TLS-PKI activation mode
 uint32 GetPID(PID)
When the device is configured in TLS-PSK mode, this functions returns the PID value of the device, this can be used by Provisioning servers to associate a PSK value
 uint32 GetHelloPacketDestInfo(Address, ConfigServerListeningPort)
Returns the information about the server which Intel(R) AMT will send Hello packets to . . .
 uint32 GetAMTFQDN(FQDN)
Intel(R) AMT's configured Fully Qualified Domain Name
 uint32 Activate(OTP, PKIDNSSuffix, provTLSMode)
Activate Intel(R) AMT using Remote Configuration
 uint32 CancelActivation()
Stops Intel(R) AMT Activation if it is currently enabled, this will prevent Intel(R) AMT from being present on the Network for Bare-Metal activation
 uint32 GetProvisioningState(state)
GetProvisioningState
 uint32 GetProvisioningInfo(PKIDNSSuffix, ConfigServerFQDN)
GetProvisioningInfo returns the FQDN of configuration server and the PKI FQDN suffix
 uint32 isTLSEnabled(enabled)
Specifies whether Intel(R) AMT TLS port is enabled
 uint32 OpenUserInitiatedConnection()
CIRA: User request to initiate a CIRA connection
 uint32 CloseUserInitiatedConnection()
CIRA: Request Intel(R) ME to close an existing CIRA connection
 uint32 GetRemoteAccessConnectionStatus(NetworkConStatus, ConnectionTrigger, MPshostName, RemoteAccessConStatus)
CIRA: Retrieves information of an active CIRA connection
 uint32 GetLocalAdminCredentials(Username, Password)
Get the AMT local Administrator credentials . . .
  Get(Instance)
Gets the representation of the instance
  Enumerate()
Enumerates the instances of this class
 uint32 Unconfigure()
Un-configure the AMT system . . .

Field Detail

Name Key

public string Name
General Information:
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.

Qualifiers:
-------------
Key
Override=Name
MaxLen=256


CreationClassName Key

public string CreationClassName
General Information:
CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

Qualifiers:
-------------
Key
MaxLen=256


SystemName Key

public string SystemName
General Information:
The Name of the scoping System.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


SystemCreationClassName Key

public string SystemCreationClassName
General Information:
The CreationClassName of the scoping System.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.CreationClassName


Method Detail

GetAMTProvisioningMode

public uint32 GetAMTProvisioningMode([OUT]uint8 mode)
Permission Information:
No permissions defined

General Information:
Returns the current provisioning (activation) mode of the device

Qualifiers:
-------------
InternalOnly=Check Intel(R) AMT 6.0 support
static
implemented


Parameters:
--------------
mode
General Information:


Qualifiers:
-------------
OUT
ValueMap={0, 1, 2, 3}
Values={None, Enterprise, Small-Business, Remote Connectivity_Service}



isRemoteConfigEnabled

public uint32 isRemoteConfigEnabled([OUT]boolean enabled)
Permission Information:
No permissions defined

General Information:
Indicates if Remote Configuration is enabled in the MEBx

Qualifiers:
-------------
static
implemented


Parameters:
--------------
enabled
General Information:


Qualifiers:
-------------
OUT



GetActivationTLSMode

public uint32 GetActivationTLSMode([OUT]uint8 mode)
Permission Information:
No permissions defined

General Information:
Indicates whether the device is using TLS-PSK or TLS-PKI activation mode

Qualifiers:
-------------
static
implemented


Parameters:
--------------
mode
General Information:


Qualifiers:
-------------
OUT
ValueMap={0, 1, 2}
Values={NOT READY, PSK, PKI}



GetPID

public uint32 GetPID([OUT]string PID)
Permission Information:
No permissions defined

General Information:
When the device is configured in TLS-PSK mode, this functions returns the PID value of the device, this can be used by Provisioning servers to associate a PSK value

Qualifiers:
-------------
static
implemented


Parameters:
--------------
PID
General Information:


Qualifiers:
-------------
OUT



GetHelloPacketDestInfo

public uint32 GetHelloPacketDestInfo([OUT]string Address, [OUT]uint16 ConfigServerListeningPort)
Permission Information:
No permissions defined

General Information:
Returns the information about the server which Intel(R) AMT will send Hello packets to. The OOB server (aka Intel(R) AMT) sends 'Hello packet' messages to this address as a mean to trigger remote configuration

Qualifiers:
-------------
static
implemented


Parameters:
--------------
Address
General Information:
returns the address information (IPv4, IPv6 or FQDN) of the configurationserver

Qualifiers:
-------------
OUT
InternalOnly=if not configured return 'provisionserver'

ConfigServerListeningPort
General Information:
TCP Port of the configuration server to send Hello packets to

Qualifiers:
-------------
OUT
InternalOnly=if not configured return '9971'



GetAMTFQDN

public uint32 GetAMTFQDN([OUT]string FQDN)
Permission Information:
No permissions defined

General Information:
Intel(R) AMT's configured Fully Qualified Domain Name

Qualifiers:
-------------
static
implemented


Parameters:
--------------
FQDN
General Information:


Qualifiers:
-------------
OUT



Activate

public uint32 Activate([IN]string OTP, [IN]string PKIDNSSuffix, [OUT]uint8 provTLSMode)
Permission Information:
Permitted realms: Administrators

General Information:
Activate Intel(R) AMT using Remote Configuration

Qualifiers:
-------------
static
implemented


Parameters:
--------------
OTP
General Information:
Optional One-Time-Password value the remote configuration service can use to authenticate the device

Qualifiers:
-------------
IN

PKIDNSSuffix
General Information:
Optional DNSSuffix to match

Qualifiers:
-------------
IN

provTLSMode
General Information:


Qualifiers:
-------------
OUT
ValueMap={0, 1, 2}
Values={NOT READY, PSK, PKI}



CancelActivation

public uint32 CancelActivation()
Permission Information:
Permitted realms: Administrators

General Information:
Stops Intel(R) AMT Activation if it is currently enabled, this will prevent Intel(R) AMT from being present on the Network for Bare-Metal activation

Qualifiers:
-------------
static
implemented


GetProvisioningState

public uint32 GetProvisioningState([OUT]uint8 state)
Permission Information:
No permissions defined

General Information:
GetProvisioningState

Qualifiers:
-------------
static
implemented


Parameters:
--------------
state
General Information:


Qualifiers:
-------------
OUT
ValueMap={0, 1, 2}
Values={PRE-Provisioning, IN-Provisioning, POST-Provisioning}



GetProvisioningInfo

public uint32 GetProvisioningInfo([OUT]string PKIDNSSuffix, [OUT]string ConfigServerFQDN)
Permission Information:
No permissions defined

General Information:
GetProvisioningInfo returns the FQDN of configuration server and the PKI FQDN suffix

Qualifiers:
-------------
static
implemented


Parameters:
--------------
PKIDNSSuffix
General Information:
PKIDNSSuffix Specified

Qualifiers:
-------------
OUT

ConfigServerFQDN
General Information:
The ConfigurationServerFQDN, set to null if not specified

Qualifiers:
-------------
OUT



isTLSEnabled

public uint32 isTLSEnabled([OUT]boolean enabled)
Permission Information:
No permissions defined

General Information:
Specifies whether Intel(R) AMT TLS port is enabled

Qualifiers:
-------------
InternalOnly=consider modifying the API to specify all open ports
static
implemented


Parameters:
--------------
enabled
General Information:


Qualifiers:
-------------
OUT



OpenUserInitiatedConnection

public uint32 OpenUserInitiatedConnection()
Permission Information:
No permissions defined

General Information:
CIRA: User request to initiate a CIRA connection

Qualifiers:
-------------
static
implemented


CloseUserInitiatedConnection

public uint32 CloseUserInitiatedConnection()
Permission Information:
No permissions defined

General Information:
CIRA: Request Intel(R) ME to close an existing CIRA connection

Qualifiers:
-------------
static
implemented


GetRemoteAccessConnectionStatus

public uint32 GetRemoteAccessConnectionStatus([OUT]uint32 NetworkConStatus, [OUT]uint32 ConnectionTrigger, [OUT]string MPshostName, [OUT]uint32 RemoteAccessConStatus)
Permission Information:
No permissions defined

General Information:
CIRA: Retrieves information of an active CIRA connection

Qualifiers:
-------------
static
implemented


Parameters:
--------------
NetworkConStatus
General Information:
Indicates the network connection status from Intel(R) AMT standpoint

Qualifiers:
-------------
OUT
ValueMap={0, 1, 2, 3}
Values={Direct, VPN, Outside Enterprise, Unknown}

ConnectionTrigger
General Information:
Indicates the trigger for the remote access establishment in case a connection status is connected/connecting

Qualifiers:
-------------
OUT
ValueMap={0, 1, 2, 3}
Values={User Initiated, Alert, Periodic, Provisioning}

MPshostName
General Information:
The MPS hostname that Intel(R) AMT is connected or trying to connect to

Qualifiers:
-------------
OUT

RemoteAccessConStatus
General Information:
the status of the connection (not connected, connecting, connected)

Qualifiers:
-------------
OUT
ValueMap={0, 1, 2}
Values={not connected, connecting, connected}



GetLocalAdminCredentials

public uint32 GetLocalAdminCredentials([OUT]string Username, [OUT]string Password)
Permission Information:
Permitted realms: Administrators

General Information:
Get the AMT local Administrator credentials. A local application or a service running as a Windows local administrator, can use this method to retrieve credentials from AMT. This application can use these credentials to authenticate to AMT during WSMAN commands.

Qualifiers:
-------------
Amended
Static
Implemented


Parameters:
--------------
Username
General Information:


Qualifiers:
-------------
OUT

Password
General Information:


Qualifiers:
-------------
OUT



Get

public  Get([OUT]OOB_Service Instance)
Permission Information:
No permissions defined

General Information:
Gets the representation of the instance

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Unconfigure

public  Unconfigure()
Permission Information:
Permitted realms: Administrators

General Information:
Un-configure the AMT system